All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class symantec.itools.awt.ScrollingPanel

Object
   |
   +----Component
           |
           +----Container
                   |
                   +----ScrollPane
                           |
                           +----symantec.itools.awt.ScrollingPanel

public class ScrollingPanel

extends ScrollPane

The ScrollingPanel is a panel with automatic scroll bars. It may contain only one component/container/panel/etc. It automatically tracks the size of this (usually large) component and provides scroll bars so the entire component may be viewed within a panel of limited size. Typically, the added component would be a panel (or some other container) which would then contain a variety of other components.

Version:

1.1, August 30, 1997

Author:

Symantec

See Also:

ScrollPane

symantec.itools.awt.ScrollingPanel()

Constructs a default ScrollingPanel.

symantec.itools.awt.ScrollingPanel(int)

Constructs a new ScrollingPanel initialized with the specified scrollbarDisplayPolicy.

symantec.itools.awt.ScrollingPanel(Component, int, int)

Constructs a new ScrollingPanel initialized with the specified component, minimum height and minimum width.

getComponent()

Gets the current component in the ScrollingPanel.

getHorizontalGap()

getMinimumHeight()

Gets the value used for the minimumSize() height of the ScrollingPanel.

getMinimumSize()

getMinimumWidth()

Gets the current value used for the minimumSize() width of the ScrollingPanel.

getPreferredSize()

getScrollLineIncrement()

getShowHorizontalScroll()

getShowVerticalScroll()

getVerticalGap()

minimumSize()

Returns the minimum dimensions to properly display this component.

preferredSize()

Returns the recommended dimensions to properly display this component.

scrollDown()

Scrolls down by the number of pixels specified in the method setScrollLineIncrement().

scrollHorizontalAbsolute(int)

Scrolls to an absolute horizontal position.

scrollLeft()

Scrolls left by the number of pixels specified in the method setScrollLineIncrement().

scrollPageDown()

Scrolls one "page" down.

scrollPageLeft()

Scrolls one "page" left.

scrollPageRight()

Scrolls one "page" right.

scrollPageUp()

Scrolls one "page" up.

scrollRight()

Scrolls right by the number of pixels specified in the method setScrollLineIncrement().

scrollUp()

Scrolls up by the number of pixels specified in the method setScrollLineIncrement().

scrollVerticalAbsolute(int)

Scrolls to an absolute vertical position.

setComponent(Component)

Sets the component in this ScrollingPanel.

setHorizontalGap(int)

setMinimumHeight(int)

Sets the value to be used for the minimumSize() height of the ScrollingPanel.

setMinimumWidth(int)

Sets the value to be used for the minimumSize() width of the ScrollingPanel.

setScrollLineIncrement(int)

setShowHorizontalScroll(boolean)

setShowVerticalScroll(boolean)

setVerticalGap(int)

public ScrollingPanel()

Constructs a default ScrollingPanel. The panel is initialized with a null component, zero minimum height and zero minimum width.

public ScrollingPanel(int scrollbarDisplayPolicy)

Constructs a new ScrollingPanel initialized with the specified scrollbarDisplayPolicy.

Parameters:

scrollbarDisplayPolicy - policy for when scrollbars should be shown

public ScrollingPanel(Component component,
                      int minWidth,
                      int minHeight)

Constructs a new ScrollingPanel initialized with the specified component, minimum height and minimum width.

Parameters:

component - the component (usually a Panel) to be scrolled

minWidth - the value to be used for the minimumSize() width of the ScrollingPanel

minHeight - the value to be used for the minimumSize() height of the ScrollingPanel

public java.awt.Component getComponent()

Gets the current component in the ScrollingPanel. This is the component that gets scrolled.

Returns:

the current component in the ScrollingPanel

See Also:

setComponent

public int getHorizontalGap()

Note: getHorizontalGap() is deprecated. removed functionality

public int getMinimumHeight()

Gets the value used for the minimumSize() height of the ScrollingPanel.

Returns:

current minimum height value

See Also:

setMinimumHeight

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class Container

public int getMinimumWidth()

Gets the current value used for the minimumSize() width of the ScrollingPanel.

Returns:

the current minimum width value

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class Container

public int getScrollLineIncrement()

public boolean getShowHorizontalScroll()

Note: getShowHorizontalScroll() is deprecated. replaced by getScrollbarDisplayPolicy

public boolean getShowVerticalScroll()

Note: getShowVerticalScroll() is deprecated. replaced by getScrollbarDisplayPolicy

public int getVerticalGap()

Note: getVerticalGap() is deprecated. removed functionality

public java.awt.Dimension minimumSize()

Returns the minimum dimensions to properly display this component. This is a standard Java AWT method which gets called to determine the minimum size of this component. The value returned is set using the setMinimumHeight() and setMinimumWidth() methods or when this ScrollingPanel is constructed.

Overrides:

minimumSize in class Container

See Also:

preferredSize, setMinimumHeight, setMinimumWidth

public java.awt.Dimension preferredSize()

Returns the recommended dimensions to properly display this component. This is a standard Java AWT method which gets called to determine the recommended size of this component. For each axis, it returns the larger of the current size or the minimum size.

Overrides:

preferredSize in class Container

See Also:

minimumSize

public void scrollDown()

Scrolls down by the number of pixels specified in the method setScrollLineIncrement(). The default is one pixel.

See Also:

scrollUp, scrollLeft, scrollRight, setScrollLineIncrement, getScrollLineIncrement

public void scrollHorizontalAbsolute(int position)

Scrolls to an absolute horizontal position. The contained component's given pixel position will be scrolled to the leftmost part of the scrolling panel. The provided position is constrained to the range [0, component's width - view port width].

Parameters:

position - the pixel position to scroll to

See Also:

scrollVerticalAbsolute

public void scrollLeft()

Scrolls left by the number of pixels specified in the method setScrollLineIncrement(). The default is one pixel.

See Also:

scrollRight, scrollUp, scrollDown, setScrollLineIncrement, getScrollLineIncrement

public void scrollPageDown()

Scrolls one "page" down. The page size is the size of this ScrollingPanel not including the scroll bar, if present.

See Also:

scrollPageUp, scrollPageLeft, scrollPageRight

public void scrollPageLeft()

Scrolls one "page" left. The page size is the size of this ScrollingPanel not including the scroll bar, if present.

See Also:

scrollPageRight, scrollPageUp, scrollPageDown

public void scrollPageRight()

Scrolls one "page" right. The page size is the size of this ScrollingPanel not including the scroll bar, if present.

See Also:

scrollPageLeft, scrollPageUp, scrollPageDown

public void scrollPageUp()

Scrolls one "page" up. The page size is the size of this ScrollingPanel not including the scroll bar, if present.

See Also:

scrollPageDown, scrollPageLeft, scrollPageRight

public void scrollRight()

Scrolls right by the number of pixels specified in the method setScrollLineIncrement(). The default is one pixel.

See Also:

scrollLeft, scrollUp, scrollDown, setScrollLineIncrement, getScrollLineIncrement

public void scrollUp()

Scrolls up by the number of pixels specified in the method setScrollLineIncrement(). The default is one pixel.

See Also:

scrollDown, scrollLeft, scrollRight, setScrollLineIncrement, getScrollLineIncrement

public void scrollVerticalAbsolute(int position)

Scrolls to an absolute vertical position. The contained component's given pixel position will be scrolled to the top line of the scrolling panel. The provided position is constrained to the range [0, component's height - view port height].

Parameters:

position - the pixel position to scroll to

See Also:

scrollHorizontalAbsolute

public void setComponent(Component comp)

Sets the component in this ScrollingPanel. This is the component that gets scrolled. The ScrollingPanel can only contain one component. Any previous component will be removed before the new one is added.

Parameters:

comp - the component to add

See Also:

getComponent

public void setHorizontalGap(int gapPixels)

Note: setHorizontalGap() is deprecated. removed functionality

public void setMinimumHeight(int minHeight)

Sets the value to be used for the minimumSize() height of the ScrollingPanel.

Parameters:

minHeight - the value to be used for the minimumSize() height of the ScrollingPanel

See Also:

getMinimumHeight

public void setMinimumWidth(int minWidth)

Sets the value to be used for the minimumSize() width of the ScrollingPanel.

Parameters:

minWidth - the value to be used for the minimumSize() width of the ScrollingPanel

See Also:

getMinimumWidth

public void setScrollLineIncrement(int scrollLineIncrement)

public void setShowHorizontalScroll(boolean cond)

Note: setShowHorizontalScroll() is deprecated. replaced by constructor which takes a scrollbarDisplayPolicy

public void setShowVerticalScroll(boolean cond)

Note: setShowVerticalScroll() is deprecated. replaced by constructor which takes a scrollbarDisplayPolicy

public void setVerticalGap(int gapPixels)

Note: setVerticalGap() is deprecated. removed functionality

All Packages  Class Hierarchy  This Package  Previous  Next  Index